docs: bootstrap first version of customizer plugin docs#313
Merged
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughMigrates all customizer documentation internal links from ChangesCustomizer Documentation Restructuring
Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/customizer/models/data-format.mdx`:
- Line 12: The doc uses the incorrect config key `training_type`; update the
text to use the actual config key `training.type` everywhere this page
references `training_type` (e.g., the sentence starting "The required format
depends on the `training_type`"), so users are pointed to the correct job
configuration field; ensure any inline code snippets or examples also show
`training.type`.
In `@docs/fern/versions/latest.yml`:
- Around line 136-138: Remove the DPO tutorial entry from the published
navigation by deleting or commenting out the navigation block that references
"DPO Customization Job" (page: DPO Customization Job, path:
../../customizer/tutorials/dpo-customization-job.mdx, slug:
dpo-customization-job) in latest.yml so the DPO tutorial is not discoverable in
the published nav; alternatively move that block into a separate
gated/unpublished YAML file used for drafts so it stays in the repo but out of
the published navigation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: cb305a49-0f09-4ea3-bd63-1331f80603b8
📒 Files selected for processing (20)
docs/customizer/about.mdxdocs/customizer/cli.mdxdocs/customizer/index.mdxdocs/customizer/manage-customization-jobs/cancel-job.mdxdocs/customizer/manage-customization-jobs/create-job.mdxdocs/customizer/manage-customization-jobs/customization-job-reference.mdxdocs/customizer/manage-customization-jobs/get-job-status.mdxdocs/customizer/manage-customization-jobs/hyperparameters.mdxdocs/customizer/manage-customization-jobs/index.mdxdocs/customizer/manage-customization-jobs/list-active-jobs.mdxdocs/customizer/manage-model-entities/create-model-entity.mdxdocs/customizer/manage-model-entities/index.mdxdocs/customizer/models/data-format.mdxdocs/customizer/models/index.mdxdocs/customizer/tutorials/import-hf-model.mdxdocs/customizer/tutorials/index.mdxdocs/customizer/tutorials/metrics.mdxdocs/customizer/tutorials/understand-configurations-and-models.mdxdocs/fern/gated-nav.ymldocs/fern/versions/latest.yml
💤 Files with no reviewable changes (1)
- docs/fern/gated-nav.yml
anubhutivyas
force-pushed
the
aalgo-223/update-ft-docs
branch
from
c0bd830 to
eef490e
Compare
Contributor
|
🌿 Preview your docs: https://nvidia-preview-aalgo-223-update-ft-docs.docs.buildwithfern.com/nemo-platform |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/customizer/about.mdx`:
- Line 289: Replace the relative source link
"tutorials/optimize-throughput.ipynb" in docs/customizer/about.mdx with the
canonical Fern nav URL for that tutorial (use
"/documentation/tutorials/optimize-throughput"), keeping the link text
unchanged; update the markdown link target where the phrase "Optimizing for
Tokens/GPU" is referenced so the href uses the canonical /documentation/...
route instead of the relative .ipynb path to satisfy the internal-linking
guidelines.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: c6de9f28-c4ec-42cf-b0f5-0abcdd5a69c8
📒 Files selected for processing (21)
docs/customizer/about.mdxdocs/customizer/cli.mdxdocs/customizer/index.mdxdocs/customizer/manage-customization-jobs/cancel-job.mdxdocs/customizer/manage-customization-jobs/create-job.mdxdocs/customizer/manage-customization-jobs/customization-job-reference.mdxdocs/customizer/manage-customization-jobs/get-job-status.mdxdocs/customizer/manage-customization-jobs/hyperparameters.mdxdocs/customizer/manage-customization-jobs/index.mdxdocs/customizer/manage-customization-jobs/list-active-jobs.mdxdocs/customizer/manage-model-entities/create-fileset.mdxdocs/customizer/manage-model-entities/create-model-entity.mdxdocs/customizer/manage-model-entities/index.mdxdocs/customizer/models/data-format.mdxdocs/customizer/models/index.mdxdocs/customizer/tutorials/import-hf-model.mdxdocs/customizer/tutorials/index.mdxdocs/customizer/tutorials/metrics.mdxdocs/customizer/tutorials/understand-configurations-and-models.mdxdocs/fern/gated-nav.ymldocs/fern/versions/latest.yml
💤 Files with no reviewable changes (2)
- docs/customizer/manage-model-entities/create-fileset.mdx
- docs/fern/gated-nav.yml
✅ Files skipped from review due to trivial changes (9)
- docs/customizer/tutorials/import-hf-model.mdx
- docs/customizer/manage-model-entities/index.mdx
- docs/customizer/tutorials/understand-configurations-and-models.mdx
- docs/customizer/tutorials/index.mdx
- docs/customizer/models/index.mdx
- docs/customizer/tutorials/metrics.mdx
- docs/customizer/index.mdx
- docs/customizer/manage-customization-jobs/hyperparameters.mdx
- docs/customizer/cli.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/customizer/models/data-format.mdx
- docs/fern/versions/latest.yml
Contributor
|
gabwow
commented
Jun 15, 2026
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/customizer/about.mdx (1)
289-289:⚠️ Potential issue | 🟠 Major | ⚡ Quick winReplace the relative tutorial link.
This is the same dead-link issue previously flagged, and it’s still pointing at
tutorials/optimize-throughput.ipynbinstead of a canonical Fern URL. As per coding guidelines, internal links must use canonical nav URLs, not relative source paths.🔧 Proposed fix
-Learn how to create a LoRA customization job with sequence packing by following the [Optimizing for Tokens/GPU](tutorials/optimize-throughput.ipynb) tutorial. +Learn how to create a LoRA customization job with sequence packing by following the [Optimizing for Tokens/GPU](/documentation/customizer-reference/tutorials/optimize-throughput) tutorial.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/customizer/about.mdx` at line 289, In the file docs/customizer/about.mdx at line 289, the link text "Optimizing for Tokens/GPU" uses a relative path reference to tutorials/optimize-throughput.ipynb which violates canonical URL guidelines. Replace the relative link path with the proper canonical Fern URL that corresponds to the optimize-throughput tutorial, ensuring it follows the project's internal link conventions for documentation references.Source: Coding guidelines
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@docs/customizer/about.mdx`:
- Line 289: In the file docs/customizer/about.mdx at line 289, the link text
"Optimizing for Tokens/GPU" uses a relative path reference to
tutorials/optimize-throughput.ipynb which violates canonical URL guidelines.
Replace the relative link path with the proper canonical Fern URL that
corresponds to the optimize-throughput tutorial, ensuring it follows the
project's internal link conventions for documentation references.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 7d45f672-69b8-4762-8eb2-f5d95f1fad7e
📒 Files selected for processing (1)
docs/customizer/about.mdx
soluwalana
reviewed
Jun 15, 2026
soluwalana
approved these changes
Jun 15, 2026
Signed-off-by: Aaron Gabow <agabow@nvidia.com>
Signed-off-by: anubhutiv <anubhutiv@nvidia.com> Signed-off-by: Aaron Gabow <agabow@nvidia.com>
Signed-off-by: Aaron Gabow <agabow@nvidia.com>
Signed-off-by: Aaron Gabow <agabow@nvidia.com>
gabwow
force-pushed
the
aalgo-223/update-ft-docs
branch
from
7a899a9 to
477fab9
Compare
Signed-off-by: Aaron Gabow <agabow@nvidia.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit